Project class interface #511

andrzej-krupka · 2024-10-24T12:31:12Z

No description provided.

maciej-flexcompute · 2024-10-25T11:20:40Z

examples/project_from_cloud_volume_mesh.py

+    params = SimulationParams(
+        operating_condition=AerospaceCondition(velocity_magnitude=100 * u.m / u.s),
+        models=[
+            Fluid(),


fluid will be added automatically, remove

Fixed in 9ba5587

maciej-flexcompute · 2024-10-25T11:33:05Z

examples/project_from_file_geometry.py

+
+fl.Env.dev.active()
+
+SOLVER_VERSION = "workbench-24.9.3"


let's be consistent with solver version. Let's always use release-24.11

Fixed in 9ba5587

maciej-flexcompute · 2024-10-25T11:33:22Z

examples/project_from_file_volume_mesh.py

+project = Project.from_file(
+    OM6wing.mesh_filename,
+    name="wing-volume-mesh-python-upload",
+    solver_version="workbench-24.9.3",


add repository-level default solver version

Fixed in 9ba5587, added __solver_version__ to version.py

maciej-flexcompute · 2024-10-25T11:40:13Z

flow360/component/project.py

+        except Flow360FileError:
+            pass
+        raise Flow360FileError(
+            f"{file} is not a geometry or volume mesh file required for project initialization."


in error message, list what file extension is expected

Fixed in 9ba5587

maciej-flexcompute · 2024-10-25T11:46:07Z

flow360/component/project.py

+    def from_file(
+        cls,
+        file: str = None,
+        name: str = None,
+        solver_version: str = None,
+        length_unit: LengthUnitType = "m",
+        tags: List[str] = None,


use pydantic's "validate_call" decorator to validate inputs

Fixed in 9ba5587, added validate_call where applicable in other user-facing methods

maciej-flexcompute · 2024-10-25T12:37:26Z

flow360/component/project.py

+                "Project is not initialized - use Project.from_file or Project.from_cloud"
+            )
+
+    def get_simulation_json(self) -> dict:


Suggested change

def get_simulation_json(self) -> dict:

def get_root_simulation_json(self) -> dict:

Fixed in 9ba5587

maciej-flexcompute · 2024-10-25T12:39:18Z

flow360/component/project.py

+        if root_type == RootType.GEOMETRY:
+            root_api = RestApi(GeometryInterface.endpoint, id=root_id)
+        elif root_type == RootType.VOLUME_MESH:
+            root_api = RestApi(VolumeMeshInterfaceV2.endpoint, id=root_id)


can we do it in constructors init_webapi ?

Fixed in 9ba5587

maciej-flexcompute · 2024-10-25T12:40:05Z

flow360/component/project.py

+            root_api = RestApi(VolumeMeshInterfaceV2.endpoint, id=root_id)
+        resp = root_api.get(method="simulation/file", params={"type": "simulation"})
+        if not isinstance(resp, dict) or "simulationJson" not in resp:
+            raise Flow360WebError("Root item type or ID is missing from project metadata")


the message seems be incorrect?

Fixed in 9ba5587

maciej-flexcompute · 2024-10-25T12:41:50Z

flow360/component/project.py

+        for _, old_entity in enumerate(old_draft_entities):
+            try:
+                registry.find_by_naming_pattern(old_entity.name)
+            except ValueError:
+                continue


I don't understand intention of this

This is pasted over from the previous cloud class but you're right - this looks like it has no effect. I'll double-check with Ben.

Fixed in 9ba5587, but might need another small change, see DM on Slack

maciej-flexcompute · 2024-10-25T12:43:26Z

flow360/component/project.py

+        RestApi(ProjectInterface.endpoint, id=self.metadata.id).patch(
+            json={
+                "lastOpenItemId": destination_id,
+                "lastOpenItemType": target.__name__,
+            }
+        )


initialise this in constructor and run:

Suggested change

RestApi(ProjectInterface.endpoint, id=self.metadata.id).patch(

json={

"lastOpenItemId": destination_id,

"lastOpenItemType": target.__name__,

}

)

self.webapi.patch(

json={

"lastOpenItemId": destination_id,

"lastOpenItemType": target.__name__,

}

)

Fixed in 9ba5587

flow360/component/project.py

benflexcompute · 2024-10-28T02:09:11Z

flow360/component/project.py

+            Whether to fork the case (default is True).
+        """
+        self._check_initialized()
+        self._case = self._run(


What if a user runs a batch of cases by tweaking parameter? Then _case will get overwritten every time a new case is submitted? Can we instead create a draft_name (which IIRC is the case/VM/SM name) to asset(or just asset ID) map instead? @maciej-flexcompute what do you think?

You're right. I was initially under the impression that these properties will hold the most recently opened assets (geometry, surface mesh, volume mesh, case) but in case of batch runs we should probably keep some history of all loaded asset objects... Maybe we could have a history interface of sorts where the user can see previous assets?

Something like

for i in range(0, 50): project.run_case(...) # Show most recent one case = project.case # Show history of all project runs for id in project.case_history(): # Load the project with a specified ID case = project.case(id)

I see. We need to fix this though since I expect the major use for python client is batch submission.

Another simple way is to just return the Case obj and ask user to manage their cases.

I added this interface in 3b7aa70, check project_from_file_geometry_multiple_runs.py for reference.

flow360/component/project.py

flow360/component/utils.py

flow360/component/project.py

examples/project_from_cloud_volume_mesh.py

* Added initial version of the Project class interface * Added examples, remove usages of cloud static functions * Entity info injection during _run() * Style fixes * Fix webapi test * Fix examples, fix from_cloud * Add case fork option * Switched docstrings to numpy style * Fix PR feedback * Fix PR feedback #2 * Fix PR feedback #3 * Fix PR feedback #4 --------- Co-authored-by: Ben <106089368+benflexcompute@users.noreply.github.com>

* Added initial version of the Project class interface * Added examples, remove usages of cloud static functions * Entity info injection during _run() * Style fixes * Fix webapi test * Fix examples, fix from_cloud * Add case fork option * Switched docstrings to numpy style * Fix PR feedback * Fix PR feedback #2 * Fix PR feedback #3 * Fix PR feedback #4 --------- Co-authored-by: andrzej-krupka <156919532+andrzej-krupka@users.noreply.github.com>

andrzej-krupka marked this pull request as draft October 24, 2024 12:31

andrzej-krupka force-pushed the andrzej/project-class branch 7 times, most recently from 2fe2045 to 9b86c19 Compare October 24, 2024 17:05

andrzej-krupka added 5 commits October 24, 2024 19:12

Added initial version of the Project class interface

29024e4

Added examples, remove usages of cloud static functions

4f82beb

Entity info injection during _run()

8ca3122

Style fixes

266df20

Fix webapi test

b6ea7cc

andrzej-krupka force-pushed the andrzej/project-class branch from 9b86c19 to b6ea7cc Compare October 24, 2024 17:12

andrzej-krupka marked this pull request as ready for review October 24, 2024 17:20

Fix examples, fix from_cloud

b9ca4a7

andrzej-krupka force-pushed the andrzej/project-class branch from 3720002 to b9ca4a7 Compare October 24, 2024 17:29

andrzej-krupka requested review from benflexcompute and maciej-flexcompute October 24, 2024 17:32

Add case fork option

6372e0e

andrzej-krupka force-pushed the andrzej/project-class branch 2 times, most recently from ee4bf29 to 723158c Compare October 24, 2024 18:08

Switched docstrings to numpy style

6f6648f

andrzej-krupka force-pushed the andrzej/project-class branch from 723158c to 6f6648f Compare October 24, 2024 18:11

maciej-flexcompute reviewed Oct 25, 2024

View reviewed changes

Fix PR feedback

9ba5587

benflexcompute reviewed Oct 28, 2024

View reviewed changes

flow360/component/project.py Outdated Show resolved Hide resolved

flow360/component/project.py Outdated Show resolved Hide resolved

flow360/component/project.py Outdated Show resolved Hide resolved

flow360/component/project.py Outdated Show resolved Hide resolved

benflexcompute reviewed Oct 28, 2024

View reviewed changes

andrzej-krupka force-pushed the andrzej/project-class branch from 076877a to c90e70f Compare October 28, 2024 11:46

benflexcompute reviewed Oct 28, 2024

View reviewed changes

flow360/component/project.py Show resolved Hide resolved

andrzej-krupka force-pushed the andrzej/project-class branch 2 times, most recently from 71a5c39 to 2939dfa Compare October 28, 2024 14:29

Fix PR feedback #2

3b7aa70

andrzej-krupka force-pushed the andrzej/project-class branch from 2939dfa to 3b7aa70 Compare October 28, 2024 14:41

benflexcompute reviewed Oct 28, 2024

View reviewed changes

flow360/component/utils.py Outdated Show resolved Hide resolved

flow360/component/utils.py Outdated Show resolved Hide resolved

flow360/component/utils.py Outdated Show resolved Hide resolved

flow360/component/utils.py Show resolved Hide resolved

Fix PR feedback #3

99f2143

andrzej-krupka force-pushed the andrzej/project-class branch from 8b2c75c to 99f2143 Compare October 28, 2024 17:23

Merge branch 'develop' into andrzej/project-class

8e1ad0b

benflexcompute approved these changes Oct 28, 2024

View reviewed changes

maciej-flexcompute reviewed Oct 28, 2024

View reviewed changes

flow360/component/utils.py Outdated Show resolved Hide resolved

flow360/component/project.py Outdated Show resolved Hide resolved

flow360/component/project.py Show resolved Hide resolved

examples/project_from_cloud_volume_mesh.py Show resolved Hide resolved

Fix PR feedback #4

d07cfe8

maciej-flexcompute approved these changes Oct 29, 2024

View reviewed changes

maciej-flexcompute merged commit ceb43dc into develop Oct 29, 2024
12 checks passed

maciej-flexcompute deleted the andrzej/project-class branch October 29, 2024 17:31

	def get_simulation_json(self) -> dict:
	def get_root_simulation_json(self) -> dict:


		fl.Env.dev.active()

		SOLVER_VERSION = "workbench-24.9.3"

Project class interface #511

Project class interface #511

Uh oh!

Conversation

andrzej-krupka commented Oct 24, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrzej-krupka Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrzej-krupka Oct 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrzej-krupka Oct 25, 2024 •

edited

Loading

andrzej-krupka Oct 28, 2024 •

edited

Loading